Update the specified index settings.

Index settings that you don't specify are left unchanged.
Specify `null` to reset a setting to its default value.

For best performance, update the index settings before you add new records to your index.


Update index settings

link for a banner defined in merchandising studio.

banners defined in the merchandising studio for the given search.

Determines how many records of a group are included in the search results.

Records with the same value for the `attributeForDistinct` attribute are considered a group.
The `distinct` setting controls how many members of the group are returned.
This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).

The `distinct` setting is ignored if `attributeForDistinct` is not set.


Whether deduplication is turned on. If true, only one member of a group is shown in the search results.

Number of members of a group of records to include in the search results.

- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/).
  The number of hits won't be correct and faceting won't work as expected.
- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.
  For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.
  Likewise, the `nbHits` response attribute contains the number of returned groups.


Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.

- `attribute`.
  The Exact ranking criterion is 1 if the query word and attribute value are the same.
  For example, a search for "road" will match the value "road", but not "road trip".

- `none`.
  The Exact ranking criterion is ignored on single-word searches.

- `word`.
  The Exact ranking criterion is 1 if the query word is found in the attribute value.
  The query word must have at least 3 characters and must not be a stop word.
  Only exact matches will be highlighted,
  partial and prefix matches won't.


Order of facet names and facet values in your UI.

Treat singular, plurals, and other forms of declensions as equivalent.
You should only use this feature for the languages used in your index.


ISO code for languages for which this feature should be active.
This overrides languages you set with `queryLanguages`.


If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.
If false, singulars, plurals, and other declensions won't be considered equivalent.


Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).

Search mode the index will use to query for results.

This setting only applies to indices, for which Algolia enabled NeuralSearch for you.


Words that should be considered optional when found in the query.

By default, records must match all words in the search query to be included in the search results.
Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
For example, if the search query is "action video" and "video" is an optional word,
the search engine runs two queries. One for "action video" and one for "action".
Records that match all words are ranked higher.

For a search query with 4 or more words **and** all its words are optional,
the number of matched words required for a record to be included in the search results increases for every 1,000 records:

- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
  results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
- If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).
  For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.

For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).


Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.


Determines if and how query words are interpreted as prefixes.

By default, only the last query word is treated as a prefix (`prefixLast`).
To turn off prefix search, use `prefixNone`.
Avoid `prefixAll`, which treats all query words as prefixes.
This might lead to counterintuitive results and makes your search slower.

For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).


Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.


Removes stop words from the search query.

Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own.
In English, "the", "a", or "and" are stop words.

You should only use this feature for the languages used in your index.


ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.

If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.
If false, stop words are not removed.


Strategy for removing words from the query when it doesn't return any results.
This helps to avoid returning empty search results.

- `none`.
  No words are removed when a query doesn't return results.

- `lastWords`.
  Treat the last (then second to last, then third to last) word as optional,
  until there are results or at most 5 words have been removed.

- `firstWords`.
  Treat the first (then second, then third) word as optional,
  until there are results or at most 5 words have been removed.

- `allOptional`.
  Treat all words as optional.

For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).


Extra data that can be used in the search UI.

You can use this to control aspects of your search UI, such as the order of facet names and values
without changing your frontend code.


Settings for the semantic search part of NeuralSearch.
Only used when `mode` is `neuralSearch`.


Indices from which to collect click and conversion events.

If null, the current index and all its replicas are used.


Order of facet values that aren't explicitly positioned with the `order` setting.

- `count`.
  Order remaining facet values by decreasing count.
  The count is the number of matching records containing this facet value.

- `alpha`.
  Sort facet values alphabetically.

- `hidden`.
  Don't show facet values that aren't explicitly positioned.


Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.


Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.

If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.


Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.

- `min`. Return matches with the lowest number of typos.
  For example, if you have matches without typos, only include those.
  But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).
- `strict`. Return matches with the two lowest numbers of typos.
  With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.


typo tolerance

Date and time when the object was updated, in RFC 3339 format.

An object with custom data.

You can store up to 32kB as custom data.


Order of facet values. One object for each facet.

widgets returned from any rules that are applied to the current search.

appId & apiKey

This feature is not enabled on your Algolia account.

Algolia docs

Algolia is a platform for building powerful end-to-end search and discovery solutions.

Home

Algolia documentation

A short, step-by-step guide to learn Algolia basics.

Algolia Launchpad

Get Started with Launchpad

Create your first index and add records to make searchable in the next steps.

Import Your Data

Imorting Data

Build your search interface using the data you recently pushed to your Algolia index.

Design Your Results

Allow your users to search through your data based on the attributes you define here.

Add Searchable Attributes

Adding Searchable Attributes

Determine how your search results should be ranked based on index attributes and objectives.

Configure Relevancy

Configuring Search Relevancy

Create your search interface leveraging Algolia InstantSearch library.

Implement Search UI

Implement Search

Learn what Algolia's search API offers: speed, relevance, search, navigation, product and content discovery, and analytics.

What is Algolia?

NeuralSearch combines the precision of keyword matching with the deep understanding of natural language and contextual relevance provided by AI-based vector search.

NeuralSearch

Learn about the building blocks of Algolia's search engine, what Algolia offers, and the full ecosystem it provides.

How Algolia works

An overview of Algolia's ecosystem. API clients, UI libraries, integrations, the dashboard, and more.

Algolia's ecosystem

Learn how you can elevate your search and discovery experience with Algolia's out-of-the-box features.

Algolia's features

Terms used at Algolia and their definitions.

Algolia glossary

Unlock Algolia's most powerful features by collecting user events with the Insights API.

Get started

Get started with click and conversion events

How to send your data to Algolia, batch large datasets, synchronize with incremental updates and atomic reindexing, or handle concurrency.

Send and update your data

Relevancy from a high-level point of view - finding records, ranking, tie-breaking, typos, and other settings.

Relevance overview

Learn how you can use Algolia Recommend to display recommendations on your site or app.

Algolia Recommend

Use AI to automate finding the best synonyms for your search.

Dynamic Synonym Suggestions

Predict the categories to which a search query belongs with AI.

Query Categorization

Dynamic Re-Ranking automatically adjusts your ranking based on user trends.

Dynamic Re-Ranking

Learn how to use Dynamic Re-Ranking to re-rank and promote popular products on category pages.

Add Dynamic Re-Ranking to category pages

Overview

Python API client

Open source libraries for building search and discovery interfaces.

Autocomplete is an open source, production-ready JavaScript library for building search and discovery experiences.

API reference

Update index settings

Authorizations

Path Parameters

Query Parameters

Body

Response